image: Update docs
authorMatthias Clasen <mclasen@redhat.com>
Wed, 15 Nov 2017 18:23:51 +0000 (13:23 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 15 Nov 2017 19:22:17 +0000 (14:22 -0500)
Mention the new icon-size style classes, update the docs
for removed arguments and return values, and add new
functions to the docs.

docs/reference/gtk/gtk4-sections.txt
gtk/gtkimage.c

index 819c76558e703a79cdf597739cd248a4d7abdf2f..8350ef34ce31c3e0e4dae9ca5727ae59f863ad43 100644 (file)
@@ -1509,6 +1509,7 @@ gtk_image_clear
 gtk_image_new
 gtk_image_set_pixel_size
 gtk_image_get_pixel_size
+gtk_image_set_icon_size
 gtk_image_get_icon_size
 <SUBSECTION Standard>
 GTK_IMAGE
index c8837a175402fbdea0d75872c7a72a13f12b2fc5..48968f4e077004c246d77580704b845d4b13506c 100644 (file)
@@ -68,7 +68,9 @@
  *
  * # CSS nodes
  *
- * GtkImage has a single CSS node with the name image.
+ * GtkImage has a single CSS node with the name image. The style classes
+ * .normal-icons or .large-icons may appear, depending on the #GtkImage::icon-size
+ * property.
  */
 
 
@@ -1037,6 +1039,10 @@ gtk_image_get_texture (GtkImage *image)
  * The returned string is owned by the #GtkImage and should not
  * be freed.
  *
+ * Note: This function was changed in 3.94 not to use out parameters
+ * anymore, but return the icon name directly. See gtk_image_get_icon_size()
+ * for a way to get the icon size.
+ *
  * Returns: (transfer none) (allow-none): the icon name, or %NULL
  *
  * Since: 2.6
@@ -1060,7 +1066,11 @@ gtk_image_get_icon_name (GtkImage *image)
  * %GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
  * The caller of this function does not own a reference to the
  * returned #GIcon.
- * 
+ *
+ * Note: This function was changed in 3.94 not to use out parameters
+ * anymore, but return the GIcon directly. See gtk_image_get_icon_size()
+ * for a way to get the icon size.
+ *
  * Returns: (transfer none) (allow-none): a #GIcon, or %NULL
  *
  * Since: 2.14